<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ExtcacheUtility</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> ExtcacheUtility</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-consts">Constants</a>
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">extends the normal cacheutility with more memcached functions</p>
	<ul class="tags">
				<li><span class="field">author:</span> feldkamp@gameforge.de</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_kata---lib---utilities---extcacheutility.php.html">/kata/lib/utilities/extcacheutility.php</a> (line <span class="field">13</span>)
		</p>
		
				
		<pre><a href="../kata_utility/CacheUtility.html">CacheUtility</a>
   |
   --ExtcacheUtility</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-consts">Constants</a>
							
															<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																								<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">boolean</span>
										<a href="#compareAndSwap" title="details" class="method-name">compareAndSwap</a>
											(<span class="var-type">float</span>&nbsp;<span class="var-name">$casToken</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$ttl</span> = <span class="var-default">0</span>], [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#decrement" title="details" class="method-name">decrement</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array</span>
										<a href="#getMulti" title="details" class="method-name">getMulti</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#increment" title="details" class="method-name">increment</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#readCas" title="details" class="method-name">readCas</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$casVariable</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>], <span class="var-type">float</span>&nbsp;<span class="var-name">$casVariable</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#_decrement" title="details" class="method-name">_decrement</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#_increment" title="details" class="method-name">_increment</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-consts">Constants</a>
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../kata_utility/CacheUtility.html">CacheUtility</a></span></p>
					<blockquote>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$casToken">CacheUtility::$casToken</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$defaultMethod">CacheUtility::$defaultMethod</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$isInitialized">CacheUtility::$isInitialized</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$memcachedClass">CacheUtility::$memcachedClass</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$method">CacheUtility::$method</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$requestCache">CacheUtility::$requestCache</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$results">CacheUtility::$results</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../kata_utility/CacheUtility.html#var$useRequestCache">CacheUtility::$useRequestCache</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodcompareAndSwap" id="compareAndSwap"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">compareAndSwap</span> (line <span class="line-number">236</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">set key only if the stored casToken equals our castoken (=key is unchanged)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			compareAndSwap
		</span>
					(<span class="var-type">float</span>&nbsp;<span class="var-name">$casToken</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$ttl</span> = <span class="var-default">0</span>], [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$casToken</span><span class="var-description">: castoken previously obtained by readCas</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: keyname</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: keyvalue</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$ttl</span><span class="var-description">: time to live in seconds</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span><span class="var-description">: method to use</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddecrement" id="decrement"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">decrement</span> (line <span class="line-number">87</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">decrement given key. if nonexistant (or not numeric) key will be assumed as 0</p>
	<ul class="tags">
				<li><span class="field">return:</span> success</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			decrement
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: key name</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span><span class="var-description">: which method to use instead of the autodetected one</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetMulti" id="getMulti"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getMulti</span> (line <span class="line-number">170</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">read multiple keys at once</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getMulti
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$ids</span><span class="var-description">: keynames</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span><span class="var-description">: which method to use</span>			</li>
				</ul>
		
			
	</div>
<a name="methodincrement" id="increment"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">increment</span> (line <span class="line-number">21</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">increment given key. if nonexistant (or not numeric) key will be assumed as 0</p>
	<ul class="tags">
				<li><span class="field">return:</span> success</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			increment
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: key name</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span><span class="var-description">: which method to use instead of the autodetected one</span>			</li>
				</ul>
		
			
	</div>
<a name="methodreadCas" id="readCas"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">readCas</span> (line <span class="line-number">154</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">read key and set comapareAndSet variable</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			readCas
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$casVariable</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>], <span class="var-type">float</span>&nbsp;<span class="var-name">$casVariable</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: keyname</span>			</li>
					<li>
				<span class="var-type">float</span>
				<span class="var-name">$casVariable</span><span class="var-description">: variable to put the cas-value into</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span><span class="var-description">: which method to use</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$casVariable</span>			</li>
				</ul>
		
			
	</div>
<a name="method_decrement" id="_decrement"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">_decrement</span> (line <span class="line-number">125</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">do the actual decrementing</p>
	<ul class="tags">
				<li><span class="field">return:</span> success</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			_decrement
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span>			</li>
				</ul>
		
			
	</div>
<a name="method_increment" id="_increment"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">_increment</span> (line <span class="line-number">59</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">do the actual incrementing</p>
	<ul class="tags">
				<li><span class="field">return:</span> success</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			_increment
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string|bool</span>&nbsp;<span class="var-name">$forceMethod</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span>			</li>
					<li>
				<span class="var-type">string|bool</span>
				<span class="var-name">$forceMethod</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../kata_utility/CacheUtility.html">CacheUtility</a></span></p>
					<blockquote>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodadd">CacheUtility::add()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methoddisableRequestCache">CacheUtility::disableRequestCache()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodenableRequestCache">CacheUtility::enableRequestCache()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodgetMemcacheStats">CacheUtility::getMemcacheStats()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodgetMethodUsed">CacheUtility::getMethodUsed()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodinitialize">CacheUtility::initialize()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodinitMemcached">CacheUtility::initMemcached()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodread">CacheUtility::read()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#methodwrite">CacheUtility::write()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#method_add">CacheUtility::_add()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#method_read">CacheUtility::_read()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#method_write">CacheUtility::_write()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../kata_utility/CacheUtility.html#method__destruct">CacheUtility::__destruct()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-vars">Vars</a>
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Constants</h4>
				<A NAME='inherited_consts'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../kata_utility/CacheUtility.html">CacheUtility</a></span></p>
					<blockquote>
													<img src="../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../kata_utility/CacheUtility.html#constCM_APC">CacheUtility::CM_APC</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../kata_utility/CacheUtility.html#constCM_EACC">CacheUtility::CM_EACC</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../kata_utility/CacheUtility.html#constCM_FILE">CacheUtility::CM_FILE</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../kata_utility/CacheUtility.html#constCM_MEMCACHE">CacheUtility::CM_MEMCACHE</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../kata_utility/CacheUtility.html#constCM_MEMCACHED">CacheUtility::CM_MEMCACHED</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../kata_utility/CacheUtility.html#constCM_XCACHE">CacheUtility::CM_XCACHE</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Thu, 23 Sep 2010 16:25:53 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>